Style

The style section contains a reference to the current visual style object, which represents the current visual definition. The definition is divided into 3 major objects:

general

The general object contains some general style definitions, such as:

  • Theme colors
  • General fonts

For example, in order to retrieve the first theme color for the currently selected theme, use the following property:

api.style.general.generalColor1.color

Theme colors can be changed by selecting a different theme from the Design themes in the ribbon.

grid

The grid object contains style definitions that are relevant to the grid design. Several ribbon buttons are connected to the grid style definition. Any call to get a grid style definition should start with:

api.style.grid

followed by the relevant property. For example, any change to the Data buttons in the Component ribbon will result a change in the gridMatrixDataText or gridMatrixDataCell properties.

In order to retrieve the current grid data font size, you should use:

api.style.grid.gridMatrixDataText[‘font-size’]

visuals

The visual object contains style definitions which are relevant to the visual's design. Several ribbon buttons are connected to the visual style definition. Any call to get a visual style definition should start with:

api.style.visuals

For example, any change to the Axes buttons in the Component ribbon will result a change in the visualsXAxis or visualsYAxis properties respectively.

In order to retrieve the current visual Y axis font color, you should use:

api.style.visuals.visualsYAxis.color